home *** CD-ROM | disk | FTP | other *** search
/ Shareware Super Platinum 8 / Shareware Super Platinum 8.iso / mac / DATABASE / DW4.ZIP;1 / DW4.MAN < prev    next >
Encoding:
Text File  |  1994-06-18  |  8.3 KB  |  397 lines
  1.  
  2.  
  3.  
  4.  
  5.                                        Preface
  6.  
  7.  
  8.         The Data-Wire Four is a Foxpro procedure designed to allow an
  9.         application to verify databases quickly and easily.  DW4 is written
  10.         in a dBASE IV compatible language called Foxpro.
  11.  
  12.         In essence, the programmer executes DW4, generating a data dictionary
  13.         program.  This data dictionary program, called DBFS.PRG, is a
  14.         "picture" of all databases in the current directory.  When executed,
  15.         DBFS verifies that all specified databases exist and have the correct
  16.         field layouts.  Structural indices are also verified.  DBFS.PRG can
  17.         be executed alone or included within a programmer's application.
  18.  
  19.         This manual is not for the beginner.  We will not be discussing how
  20.         to use MS-DOS, or Foxpro.  Examples will be brief, and there will be
  21.         a lot of technical notes within the regular discussions.
  22.  
  23.         My advice is to peruse the contents of this manual to familiarize
  24.         yourself with its information.  You also might want to familiarize
  25.         yourself with the DW4 source code.
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                      - Page 1 -
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.                              Copyright/License/Warranty
  72.  
  73.  
  74.  
  75.  
  76.         This document and the program Data Wire Four ("the software") are
  77.         copyrighted by the author.  The copyright owner hereby licenses you
  78.         to use the software given these restrictions:
  79.  
  80.  
  81.              o  the program shall be supplied in its original, unmodified
  82.                 form, which includes this documentation;
  83.  
  84.              o  for-profit use without a license is prohibited;
  85.  
  86.              o  the program may not be included - or bundled - with other
  87.                 goods or services.  Exceptions may be granted upon written
  88.                 request only.
  89.  
  90.              o  no fee is charged beyond a reasonable amount for the media
  91.                 and handling ($10 maximum suggested);
  92.  
  93.  
  94.              There is no warranty of any kind.  The copyright owner may not
  95.              be held liable for any damages, including any lost profits or
  96.              other incidental or consequential damages arising out of or
  97.              inability to use the software.  By using the software, you agree
  98.              to this.
  99.  
  100.  
  101.         Shareware
  102.  
  103.              DW4 is distributed as Shareware.  It is not free software.
  104.              You are free to try it and make copies for others.  If you
  105.              continue to use this application beyond a reasonable trial
  106.              period, you are required to register it with the distributor
  107.              and author.
  108.  
  109.  
  110.         ASP Ombudsman
  111.  
  112.              This program is produced by a member of the Association of
  113.              Shareware Professionals (ASP).  ASP wants to make sure that the
  114.              shareware principle works for you.  If you are unable to resolve
  115.              a shareware-related problem with an ASP member by contacting the
  116.              member directly, ASP may be able to help.  The ASP Ombudsman can
  117.              help you resolve a dispute or problem with an ASP member, but
  118.              does not provide technical support for members' products.
  119.  
  120.              Please write to the ASP Ombudsman at 545 Grover Road, Muskegon,
  121.              MI 49442-9427 USA, FAX 616-788-2765 or send a CompuServe message
  122.              via CompuServe Mail to ASP Ombudsman 70007,3536.
  123.  
  124.  
  125.  
  126.              Copyright (C) 1992 Dennis Allen.  All rights reserved.  All
  127.              trademarks mentioned herein belong to their respective owners.
  128.  
  129.                                      - Page 2 -
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.                                   TABLE OF CONTENTS
  138.  
  139.  
  140.         Preface                                                    1
  141.         Copyright/License/Warranty                                 2
  142.         Using Data Wire Four                                       4
  143.             Using DBFS.PRG                                         4
  144.             Specifying a file name                                 5
  145.         Distribution                                               5
  146.         Index                                                      6
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                      - Page 3 -
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.                                 Using Data Wire Four
  204.  
  205.  
  206.         Using Data Wire Four is simple.  First, you must be the data
  207.         directory of your application.  Remove all temporary files.  If you
  208.         have structural indices, make sure the index tags are in the desired
  209.         order.  Then, at the DOS prompt, type:
  210.  
  211.                   FOX  DW4
  212.  
  213.         and press [Enter].  Data Wire Four will generate a program called
  214.         "DBFS.PRG".  If there are "FXP" files in the current directory,
  215.         "DBFS.PRG" will be compiled.
  216.  
  217.  
  218.                                    Using DBFS.PRG
  219.  
  220.  
  221.         You may execute DBFS.PRG from either the Foxpro command window, or
  222.         from within your application.  If DBFS.PRG is executed from the
  223.         Foxpro command window, a WAIT WINDOW is performed before exiting.
  224.  
  225.         Now DBFS.PRG takes the following parameters:
  226.  
  227.  
  228.              cPATH          -    Path of data files
  229.              bBACK          -    Flag, .t. = create backup files (default)
  230.  
  231.  
  232.         If cPATH is not specified, DBFS.PRG will use the path in cDATAPATH.
  233.         If cDATAPATH does not exist, the current directory is assumed.
  234.  
  235.         Unless bBACK is specified as false, backup will occur.  Example:
  236.  
  237.  
  238.              DO DBFS WITH "\DMAIL4", .T.
  239.  
  240.  
  241.         In this example, DBFS.PRG will verify all database files in the
  242.         DMAIL4 directory.  If any database file has to be modified, a backup
  243.         of the original is created.
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                      - Page 4 -
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.                                 Using Data Wire Four
  270.  
  271.  
  272.  
  273.         When DBFS.PRG is executed, all databases in the specified directory
  274.         are inspected.  If a database file doesn't exist, it is created.  If
  275.         a database file is missing a field, it is added.  If a field is not
  276.         the correct length, it is lengthened.  If a structural index tag is
  277.         missing or not in the correct order, the index tags are rebuilt.
  278.  
  279.  
  280.         Note:  DBFS.PRG cannot handle index tags containing relationships
  281.         (SET RELATION TO).  In addition, DBFS.PRG can only handle structural
  282.         compound indices.
  283.  
  284.  
  285.                                Specifying a file name
  286.  
  287.  
  288.  
  289.  
  290.         In Data Wire Four, you can specify a file name.  At the DOS prompt,
  291.         for example, you could type:
  292.  
  293.                   FOX  DW4  TEMP
  294.  
  295.         A file called "TEMP.PRG" (not "DBFS.PRG") would then be generated.
  296.  
  297.  
  298.         Note:  DW4 ignores the database file FOXUSER.DBF.  If the file
  299.         DBFS.PRG is generated, DW4 will also ignore the database file
  300.         SCR.DBF, and all database files beginning with "Q".
  301.  
  302.  
  303.                                     Distribution
  304.  
  305.  
  306.         Now you're ready to add DBFS.PRG to your application.  I suggest
  307.         executing DBFS.PRG before your main menu loop.  In this way, all
  308.         database files are verified BEFORE your application can execute
  309.         sensitive code.  Distributing DBFS.PRG with your application will
  310.         ensure that any client, no matter how old the data files, has the
  311.         correct file layouts.
  312.  
  313.         Note:  If you decide to distribute DBFS.PRG within your application,
  314.         please add the following copyright notice to your installation:
  315.  
  316.  
  317.              Copyright Notices:
  318.              DBFS.PRG is supplied by Dennis Allen
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                      - Page 5 -
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.                                         Index
  336.  
  337.  
  338.             Copyright/License/Warranty  2
  339.             DBFS.PRG  1, 4, 5
  340.             Distribution  5
  341.             DW4  1
  342.             Foxpro  1
  343.             Index  6
  344.             Preface  1
  345.             Specifying a file name  5
  346.             TABLE OF CONTENTS  3
  347.             Using Data Wire Four  4
  348.             Using DBFS.PRG  4
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.                                      - Page 6 -
  394.  
  395.  
  396.  
  397.